Skip to content

docs: document the dev-server OOM workaround for large generations - #808

Merged
wyuc merged 2 commits into
THU-MAIC:mainfrom
mvanhorn:docs/625-dev-server-oom-troubleshooting
Jul 2, 2026
Merged

docs: document the dev-server OOM workaround for large generations#808
wyuc merged 2 commits into
THU-MAIC:mainfrom
mvanhorn:docs/625-dev-server-oom-troubleshooting

Conversation

@mvanhorn

Copy link
Copy Markdown
Contributor

Summary

Adds a "Troubleshooting" section to the Getting Started docs documenting the dev-server out-of-memory crash that occurs when generating large content locally. The note explains the Jest worker encountered 2 child process exceptions, exceeding retry limit symptom, clarifies it is a dev-only Next.js worker-fork limitation rather than an OpenMAIC runtime bug, and gives the maintainer's heap-size workaround (NODE_OPTIONS=--max-old-space-size=4096) for both macOS/Linux and Windows PowerShell. The fix was previously only in a single issue comment, so the next local user hitting this crash now has a documented path. This documents the existing dev-only workaround only and does not claim a code fix; production builds are unaffected.

Related Issues

Fixes #625

Changes

  • Add a "Troubleshooting" section to packages/docs/content/docs/getting-started.mdx, placed after the ## Run section, documenting the dev-server OOM symptom, its root cause (dev-only Next.js worker fork for App Router dynamic routes), and the NODE_OPTIONS=--max-old-space-size=4096 workaround for macOS/Linux and Windows PowerShell.

Type of Change

  • Documentation update

Verification

Steps to reproduce / test

  1. Open packages/docs/content/docs/getting-started.mdx.
  2. Confirm the new ## Troubleshooting section renders after ## Run and before ## Build for production.
  3. Confirm both shell code blocks (macOS/Linux and Windows PowerShell) display correctly.

What you personally verified

  • Verified the new section is the only change (single-file, additive diff) and the MDX structure (frontmatter + headings + fenced code blocks) is well-formed.
  • Verified the documented command text matches the maintainer's workaround in Turbopack Jest worker 在 LLM 生成大内容时崩溃 #625, adjusted to the docs' pnpm dev convention.
  • I did not run a full local OOM reproduction; the change only surfaces the maintainer's already-confirmed workaround and does not alter any runtime code.

Evidence

  • CI passes (pnpm check && pnpm lint && npx tsc --noEmit)
  • Manually tested locally
  • Screenshots / recordings attached (if UI changes)

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have added/updated documentation as needed
  • My changes do not introduce new warnings

AI was used for assistance.

@wyuc wyuc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accurate and well-scoped — this matches the dev-mode OOM behavior we've seen with large generations (Next dev's internal worker pool, unrelated to Jest/testing), and the heap-sizing caveat plus the production-unaffected note are both correct. Thanks!

@wyuc
wyuc merged commit cd5f997 into THU-MAIC:main Jul 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Turbopack Jest worker 在 LLM 生成大内容时崩溃

2 participants